home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet internetowy / Anonimowosc i bezpieczenstwo / TOR 0.1.1.24 / vidalia-bundle-0.1.1.24-0.0.7.exe / Tor / Documents / control-spec.txt < prev    next >
Text File  |  2006-09-24  |  31KB  |  803 lines
  1. $Id: control-spec.txt 8479 2006-09-24 17:20:41Z nickm $
  2.  
  3.                    TC: A Tor control protocol (Version 1)
  4.  
  5. 0. Scope
  6.  
  7.   This document describes an implementation-specific protocol that is used
  8.   for other programs (such as frontend user-interfaces) to communicate with a
  9.   locally running Tor process.  It is not part of the Tor onion routing
  10.   protocol.
  11.  
  12.   This protocol replaces version 0 of TC, which is now deprecated.  For
  13.   reference, TC is described in "control-spec-v0.txt".  Implementors are
  14.   recommended to avoid using TC directly, but instead to use a library that
  15.   can easily be updated to use the newer protocol.  (Version 0 is used by Tor
  16.   versions 0.1.0.x; the protocol in this document only works with Tor
  17.   versions in the 0.1.1.x series and later.)
  18.  
  19. 1. Protocol outline
  20.  
  21.   TC is a bidirectional message-based protocol.  It assumes an underlying
  22.   stream for communication between a controlling process (the "client"
  23.   or "controller") and a Tor process (or "server").  The stream may be
  24.   implemented via TCP, TLS-over-TCP, a Unix-domain socket, or so on,
  25.   but it must provide reliable in-order delivery.  For security, the
  26.   stream should not be accessible by untrusted parties.
  27.  
  28.   In TC, the client and server send typed messages to each other over the
  29.   underlying stream.  The client sends "commands" and the server sends
  30.   "replies".
  31.  
  32.   By default, all messages from the server are in response to messages from
  33.   the client.  Some client requests, however, will cause the server to send
  34.   messages to the client indefinitely far into the future.  Such
  35.   "asynchronous" replies are marked as such.
  36.  
  37.   Servers respond to messages in the order messages are received.
  38.  
  39. 2. Message format
  40.  
  41. 2.1. Description format
  42.  
  43.   The message formats listed below use ABNF as described in RFC2234.
  44.   The protocol itself is loosely based on SMTP (see RFC 2821).
  45.  
  46.   We use the following nonterminals from RFC2822: atom, qcontent
  47.  
  48.   We define the following general-use nonterminals:
  49.  
  50.      String = DQUOTE *qcontent DQUOTE
  51.  
  52.   There are explicitly no limits on line length.  All 8-bit characters are
  53.   permitted unless explicitly disallowed.
  54.  
  55. 2.2. Commands from controller to Tor
  56.  
  57.     Command = Keyword Arguments CRLF / "+" Keyword Arguments CRLF Data
  58.     Keyword = 1*ALPHA
  59.     Arguments = *(SP / VCHAR)
  60.  
  61.   Specific commands and their arguments are described below in section 3.
  62.  
  63. 2.3. Replies from Tor to the controller
  64.  
  65.     Reply = *(MidReplyLine / DataReplyLine) EndReplyLine
  66.  
  67.     MidReplyLine = "-" ReplyLine
  68.     DataReplyLine = "+" ReplyLine Data
  69.     EndReplyLine = SP ReplyLine
  70.     ReplyLine = StatusCode [ SP ReplyText ]  CRLF
  71.     ReplyText = XXXX
  72.     StatusCode = XXXX
  73.  
  74.   Specific replies are mentioned below in section 3, and described more fully
  75.   in section 4.
  76.  
  77. 2.4. General-use tokens
  78.  
  79.   ; Identifiers for servers.
  80.   ServerID = Nickname / Fingerprint
  81.   Nickname = 1*19 NicknameChar
  82.   NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9"
  83.   Fingerprint = "$" 40*HEXDIG
  84.  
  85.   ; Unique identifiers for streams or circuits.  Currently, Tor only
  86.   ; uses digits, but this may change
  87.   StreamID = 1*16 IDChar
  88.   CircuitID = 1*16 IDChar
  89.   IDChar = ALPHA / DIGIT
  90.  
  91.   Address = ip4-address / ip6-address / hostname   (XXXX Define these)
  92.  
  93.   ; A "Data" section is a sequence of octets concluded by the terminating
  94.   ; sequence CRLF "." CRLF.  The terminating sequence may not appear in the
  95.   ; body of the data.  Leading periods on lines in the data are escaped with
  96.   ; an additional leading period as in RFC2821 section 4.5.2
  97.   Data = *DataLine "." CRLF
  98.   DataLine = CRLF / "." 1*LineItem CRLF / NonDotItem *LineItem CRLF
  99.   LineItem = NonCR / 1*CR NonCRLF
  100.   NonDotItem = NonDotCR / 1*CR NonCRLF
  101.  
  102. 3. Commands
  103.  
  104.   All commands and other keywords are case-insensitive.
  105.  
  106. 3.1. SETCONF
  107.  
  108.   Change the value of one or more configuration variables.  The syntax is:
  109.  
  110.     "SETCONF" 1*(SP keyword ["=" String]) CRLF
  111.  
  112.   Tor behaves as though it had just read each of the key-value pairs
  113.   from its configuration file.  Keywords with no corresponding values have
  114.   their configuration values reset to 0 or NULL (use RESETCONF if you want
  115.   to set it back to its default).  SETCONF is all-or-nothing: if there
  116.   is an error in any of the configuration settings, Tor sets none of them.
  117.  
  118.   Tor responds with a "250 configuration values set" reply on success.
  119.   If some of the listed keywords can't be found, Tor replies with a
  120.   "552 Unrecognized option" message. Otherwise, Tor responds with a
  121.   "513 syntax error in configuration values" reply on syntax error, or a
  122.   "553 impossible configuration setting" reply on a semantic error.
  123.  
  124.   When a configuration option takes multiple values, or when multiple
  125.   configuration keys form a context-sensitive group (see GETCONF below), then
  126.   setting _any_ of the options in a SETCONF command is taken to reset all of
  127.   the others.  For example, if two ORBindAddress values are configured, and a
  128.   SETCONF command arrives containing a single ORBindAddress value, the new
  129.   command's value replaces the two old values.
  130.  
  131. 3.2. RESETCONF
  132.  
  133.   Remove all settings for a given configuration option entirely, assign
  134.   its default value (if any), and then assign the String provided.
  135.   Typically the String is left empty, to simply set an option back to
  136.   its default. The syntax is:
  137.  
  138.     "RESETCONF" 1*(SP keyword ["=" String]) CRLF
  139.  
  140.   Otherwise it behaves like SETCONF above.
  141.  
  142. 3.3. GETCONF
  143.  
  144.   Request the value of a configuration variable.  The syntax is:
  145.  
  146.     "GETCONF" 1*(SP keyword) CRLF
  147.  
  148.   If all of the listed keywords exist in the Tor configuration, Tor replies
  149.   with a series of reply lines of the form:
  150.       250 keyword=value
  151.   If any option is set to a 'default' value semantically different from an
  152.   empty string, Tor may reply with a reply line of the form:
  153.       250 keyword
  154.  
  155.   If some of the listed keywords can't be found, Tor replies with a
  156.   "552 unknown configuration keyword" message.
  157.  
  158.   If an option appears multiple times in the configuration, all of its
  159.   key-value pairs are returned in order.
  160.  
  161.   Some options are context-sensitive, and depend on other options with
  162.   different keywords.  These cannot be fetched directly.  Currently there
  163.   is only one such option: clients should use the "HiddenServiceOptions"
  164.   virtual keyword to get all HiddenServiceDir, HiddenServicePort,
  165.   HiddenServiceNodes, and HiddenServiceExcludeNodes option settings.
  166.  
  167. 3.4. SETEVENTS
  168.  
  169.   Request the server to inform the client about interesting events.  The
  170.   syntax is:
  171.  
  172.      "SETEVENTS" [SP "EXTENDED"] *(SP EventCode) CRLF
  173.  
  174.      EventCode = "CIRC" / "STREAM" / "ORCONN" / "BW" / "DEBUG" /
  175.          "INFO" / "NOTICE" / "WARN" / "ERR" / "NEWDESC" / "ADDRMAP" /
  176.          "AUTHDIR_NEWDESCS"
  177.  
  178.   Any events *not* listed in the SETEVENTS line are turned off; thus, sending
  179.   SETEVENTS with an empty body turns off all event reporting.
  180.  
  181.   The server responds with a "250 OK" reply on success, and a "552
  182.   Unrecognized event" reply if one of the event codes isn't recognized.  (On
  183.   error, the list of active event codes isn't changed.)
  184.  
  185.   If the flag string "EXTENDED" is provided, Tor may provide extra
  186.   information with events for this connection; see 4.1 for more information.
  187.   NOTE: All events on a given connection will be provided in extended format,
  188.   or none.
  189.   NOTE: "EXTENDED" is only supported in Tor 0.1.1.9-alpha or later.
  190.  
  191. 3.5. AUTHENTICATE
  192.  
  193.   Sent from the client to the server.  The syntax is:
  194.      "AUTHENTICATE" [ SP 1*HEXDIG / QuotedString ] CRLF
  195.  
  196.   The server responds with "250 OK" on success or "515 Bad authentication" if
  197.   the authentication cookie is incorrect.
  198.  
  199.   The format of the 'cookie' is implementation-dependent; see 5.1 below for
  200.   information on how the standard Tor implementation handles it.
  201.  
  202.   If Tor requires authentication and the controller has not yet sent an
  203.   AUTHENTICATE message, Tor sends a "514 authentication required" reply to
  204.   any other kind of message.
  205.  
  206. 3.6. SAVECONF
  207.  
  208.   Sent from the client to the server.  The syntax is:
  209.      "SAVECONF" CRLF
  210.  
  211.   Instructs the server to write out its config options into its torrc. Server
  212.   returns "250 OK" if successful, or "551 Unable to write configuration
  213.   to disk" if it can't write the file or some other error occurs.
  214.  
  215. 3.7. SIGNAL
  216.  
  217.   Sent from the client to the server. The syntax is:
  218.  
  219.      "SIGNAL" SP Signal CRLF
  220.  
  221.      Signal = "RELOAD" / "SHUTDOWN" / "DUMP" / "DEBUG" / "HALT" /
  222.               "HUP" / "INT" / "USR1" / "USR2" / "TERM" / "NEWNYM"
  223.  
  224.   The meaning of the signals are:
  225.  
  226.       RELOAD    -- Reload: reload config items, refetch directory. (like HUP)
  227.       SHUTDOWN  -- Controlled shutdown: if server is an OP, exit immediately.
  228.                    If it's an OR, close listeners and exit after 30 seconds.
  229.                    (like INT)
  230.       DUMP      -- Dump stats: log information about open connections and
  231.                    circuits. (like USR1)
  232.       DEBUG     -- Debug: switch all open logs to loglevel debug. (like USR2)
  233.       HALT      -- Immediate shutdown: clean up and exit now. (like TERM)
  234.       NEWNYM    -- Switch to clean circuits, so new application requests
  235.                    don't share any circuits with old ones.
  236.  
  237.   The server responds with "250 OK" if the signal is recognized (or simply
  238.   closes the socket if it was asked to close immediately), or "552
  239.   Unrecognized signal" if the signal is unrecognized.
  240.  
  241. 3.8. MAPADDRESS
  242.  
  243.   Sent from the client to the server.  The syntax is:
  244.  
  245.     "MAPADDRESS" 1*(Address "=" Address SP) CRLF
  246.  
  247.   The first address in each pair is an "original" address; the second is a
  248.   "replacement" address.  The client sends this message to the server in
  249.   order to tell it that future SOCKS requests for connections to the original
  250.   address should be replaced with connections to the specified replacement
  251.   address.  If the addresses are well-formed, and the server is able to
  252.   fulfill the request, the server replies with a 250 message:
  253.     250-OldAddress1=NewAddress1
  254.     250 OldAddress2=NewAddress2
  255.  
  256.   containing the source and destination addresses.  If request is
  257.   malformed, the server replies with "512 syntax error in command
  258.   argument".  If the server can't fulfill the request, it replies with
  259.   "451 resource exhausted".
  260.  
  261.   The client may decline to provide a body for the original address, and
  262.   instead send a special null address ("0.0.0.0" for IPv4, "::0" for IPv6, or
  263.   "." for hostname), signifying that the server should choose the original
  264.   address itself, and return that address in the reply.  The server
  265.   should ensure that it returns an element of address space that is unlikely
  266.   to be in actual use.  If there is already an address mapped to the
  267.   destination address, the server may reuse that mapping.
  268.  
  269.   If the original address is already mapped to a different address, the old
  270.   mapping is removed.  If the original address and the destination address
  271.   are the same, the server removes any mapping in place for the original
  272.   address.
  273.  
  274.   Example:
  275.     C: MAPADDRESS 0.0.0.0=tor.eff.org 1.2.3.4=tor.freehaven.net
  276.     S: 250-127.192.10.10=tor.eff.org
  277.     S: 250 1.2.3.4=tor.freehaven.net
  278.  
  279.   {Note: This feature is designed to be used to help Tor-ify applications
  280.   that need to use SOCKS4 or hostname-less SOCKS5.  There are three
  281.   approaches to doing this:
  282.      1. Somehow make them use SOCKS4a or SOCKS5-with-hostnames instead.
  283.      2. Use tor-resolve (or another interface to Tor's resolve-over-SOCKS
  284.         feature) to resolve the hostname remotely.  This doesn't work
  285.         with special addresses like x.onion or x.y.exit.
  286.      3. Use MAPADDRESS to map an IP address to the desired hostname, and then
  287.         arrange to fool the application into thinking that the hostname
  288.         has resolved to that IP.
  289.   This functionality is designed to help implement the 3rd approach.}
  290.  
  291.   Mappings set by the controller last until the Tor process exits:
  292.   they never expire. If the controller wants the mapping to last only
  293.   a certain time, then it must explicitly un-map the address when that
  294.   time has elapsed.
  295.  
  296. 3.9. GETINFO
  297.  
  298.   Sent from the client to the server.  The syntax is as for GETCONF:
  299.     "GETINFO" 1*(SP keyword) CRLF
  300.   one or more NL-terminated strings.  The server replies with an INFOVALUE
  301.   message, or a 551 or 552 error.
  302.  
  303.   Unlike GETCONF, this message is used for data that are not stored in the Tor
  304.   configuration file, and that may be longer than a single line.  On success,
  305.   one ReplyLine is sent for each requested value, followed by a final 250 OK
  306.   ReplyLine.  If a value fits on a single line, the format is:
  307.       250-keyword=value
  308.   If a value must be split over multiple lines, the format is:
  309.       250+keyword=
  310.       value
  311.       .
  312.   Recognized keys and their values include:
  313.  
  314.     "version" -- The version of the server's software, including the name
  315.       of the software. (example: "Tor 0.0.9.4")
  316.  
  317.     "config-file" -- The location of Tor's configuration file ("torrc").
  318.  
  319.     "desc/id/<OR identity>" or "desc/name/<OR nickname>" -- the latest
  320.       server descriptor for a given OR, NUL-terminated.
  321.  
  322.     "desc/all-recent" -- the latest server descriptor for every router that
  323.       Tor knows about.
  324.  
  325.     "network-status" -- a space-separated list of all known OR identities.
  326.       This is in the same format as the router-status line in directories;
  327.       see tor-spec.txt for details.
  328.  
  329.     "addr-mappings/all"
  330.     "addr-mappings/config"
  331.     "addr-mappings/cache"
  332.     "addr-mappings/control" -- a space-separated list of address
  333.       mappings, each in the form of "from-address=to-address".
  334.       The 'config' key returns those address mappings set in the
  335.       configuration; the 'cache' key returns the mappings in the
  336.       client-side DNS cache; the 'control' key returns the mappings set
  337.       via the control interface; the 'all' target returns the mappings
  338.       set through any mechanism.
  339.  
  340.     "circuit-status"
  341.       A series of lines as for a circuit status event. Each line is of
  342.       the form:
  343.          CircuitID SP CircStatus SP Path CRLF
  344.  
  345.     "stream-status"
  346.       A series of lines as for a stream status event.  Each is of the form:
  347.          StreamID SP StreamStatus SP CircID SP Target CRLF
  348.  
  349.     "orconn-status"
  350.       A series of lines as for an OR connection status event.  Each is of the
  351.       form:
  352.          ServerID SP ORStatus CRLF
  353.  
  354.     "entry-guards"
  355.       A series of lines listing the currently chosen entry guards, if any.
  356.       Each is of the form:
  357.          ServerID  SP (Status-with-time / Status) CRLF
  358.  
  359.          Status-with-time = ("down" / "unlisted") SP ISOTime
  360.          Status = ("up" / "never-connected")
  361.  
  362.       [From 0.1.1.4-alpha to 0.1.1.10-alpha, this was called "helper-nodes".
  363.        Tor still supports calling it that for now, but support will be
  364.        removed in the future.]
  365.  
  366.     "accounting/enabled"
  367.     "accounting/hibernating"
  368.     "accounting/bytes"
  369.     "accounting/bytes-left"
  370.     "accounting/interval-start"
  371.     "accounting/interval-wake"
  372.     "accounting/interval-end"
  373.       Information about accounting status.  If accounting is enabled,
  374.       "enabled" is 1; otherwise it is 0.  The "hibernating" field is "hard"
  375.       if we are accepting no data; "soft" if we're accepting no new
  376.       connections, and "awake" if we're not hibernating at all.  The "bytes"
  377.       and "bytes-left" fields contain (read-bytes SP write-bytes), for the
  378.       start and the rest of the interval respectively.  The 'interval-start'
  379.       and 'interval-end' fields are the borders of the current interval; the
  380.       'interval-wake' field is the time within the current interval (if any)
  381.       where we plan[ned] to start being active.
  382.  
  383.     "config/names"
  384.       A series of lines listing the available configuration options. Each is
  385.       of the form:
  386.          OptionName SP OptionType [ SP Documentation ] CRLF
  387.          OptionName = Keyword
  388.          OptionType = "Integer" / "TimeInterval" / "DataSize" / "Float" /
  389.            "Boolean" / "Time" / "CommaList" / "Dependant" / "Virtual" /
  390.            "String" / "LineList"
  391.          Documentation = Text
  392.  
  393.     "info/names"
  394.       A series of lines listing the available GETINFO options.  Each is of
  395.       one of these forms:
  396.          OptionName SP Documentation CRLF
  397.          OptionPrefix SP Documentation CRLF
  398.          OptionPrefix = OptionName "/*"
  399.  
  400.     "dir/status/authority"
  401.     "dir/status/fp/<F>"
  402.     "dir/status/fp/<F1>+<F2>+<F3>"
  403.     "dir/status/all"
  404.     "dir/server/fp/<F>"
  405.     "dir/server/fp/<F1>+<F2>+<F3>"
  406.     "dir/server/d/<D>"
  407.     "dir/server/d/<D1>+<D2>+<D3>"
  408.     "dir/server/authority"
  409.     "dir/server/all"
  410.       [DRAFT] [Not Implemented] A series of lines listing directory
  411.       contents, provided according to the specification for the URLs listed
  412.       in Section 4.4 of dir-spec.txt.  Note that Tor MUST NOT provide
  413.       private information, such as descriptors for routers not marked as
  414.       general-purpose.  When asked for 'authority' information for which this
  415.       Tor is not authoritative, Tor replies with an empty string.
  416.  
  417.   Examples:
  418.      C: GETINFO version desc/name/moria1
  419.      S: 250+desc/name/moria=
  420.      S: [Descriptor for moria]
  421.      S: .
  422.      S: 250-version=Tor 0.1.1.0-alpha-cvs
  423.      S: 250 OK
  424.  
  425. 3.10. EXTENDCIRCUIT
  426.  
  427.   Sent from the client to the server.  The format is:
  428.       "EXTENDCIRCUIT" SP CircuitID SP
  429.                       ServerID *("," ServerID) SP
  430.                       ("purpose=" Purpose) CRLF
  431.  
  432.   This request takes one of two forms: either the CircuitID is zero, in
  433.   which case it is a request for the server to build a new circuit according
  434.   to the specified path, or the CircuitID is nonzero, in which case it is a
  435.   request for the server to extend an existing circuit with that ID according
  436.   to the specified path.
  437.  
  438.   If CircuitID is 0 and "purpose=" is specified, then the circuit's
  439.   purpose is set. Two choices are recognized: "general" and
  440.   "controller". If not specified, circuits are created as "general".
  441.  
  442.   If the request is successful, the server sends a reply containing a
  443.   message body consisting of the CircuitID of the (maybe newly created)
  444.   circuit. The syntax is "250" SP "EXTENDED" SP CircuitID CRLF.
  445.  
  446. 3.11. SETCIRCUITPURPOSE
  447.  
  448.   Sent from the client to the server.  The format is:
  449.       "SETCIRCUITPURPOSE" SP CircuitID SP Purpose CRLF
  450.  
  451.   This changes the circuit's purpose. See EXTENDCIRCUIT above for details.
  452.  
  453. 3.12. SETROUTERPURPOSE
  454.  
  455.   Sent from the client to the server.  The format is:
  456.       "SETROUTERPURPOSE" SP NicknameOrKey SP Purpose CRLF
  457.  
  458.   This changes the descriptor's purpose. See +POSTDESCRIPTOR below
  459.   for details.
  460.  
  461. 3.13. ATTACHSTREAM
  462.  
  463.   Sent from the client to the server.  The syntax is:
  464.      "ATTACHSTREAM" SP StreamID SP CircuitID CRLF
  465.  
  466.   This message informs the server that the specified stream should be
  467.   associated with the specified circuit.  Each stream may be associated with
  468.   at most one circuit, and multiple streams may share the same circuit.
  469.   Streams can only be attached to completed circuits (that is, circuits that
  470.   have sent a circuit status 'BUILT' event or are listed as built in a
  471.   GETINFO circuit-status request).
  472.  
  473.   If the circuit ID is 0, responsibility for attaching the given stream is
  474.   returned to Tor.
  475.  
  476.   Tor responds with "250 OK" if it can attach the stream, 552 if the circuit
  477.   or stream didn't exist, or 551 if the stream couldn't be attached for
  478.   another reason.
  479.  
  480.   {Implementation note: Tor will close unattached streams by itself,
  481.   roughly two minutes after they are born. Let the developers know if
  482.   that turns out to be a problem.}
  483.  
  484.   {Implementation note: By default, Tor automatically attaches streams to
  485.   circuits itself, unless the configuration variable
  486.   "__LeaveStreamsUnattached" is set to "1".  Attempting to attach streams
  487.   via TC when "__LeaveStreamsUnattached" is false may cause a race between
  488.   Tor and the controller, as both attempt to attach streams to circuits.}
  489.  
  490.   {Implementation note: You can try to attachstream to a stream that
  491.   has already sent a connect or resolve request but hasn't succeeded
  492.   yet, in which case Tor will detach the stream from its current circuit
  493.   before proceeding with the new attach request.}
  494.  
  495. 3.14. POSTDESCRIPTOR
  496.  
  497.   Sent from the client to the server. The syntax is:
  498.     "+POSTDESCRIPTOR" ("purpose=" Purpose) CRLF Descriptor CRLF "." CRLF
  499.  
  500.   This message informs the server about a new descriptor. If Purpose is
  501.   specified, it must be either "general" or "controller", else we
  502.   return a 552 error.
  503.  
  504.   The descriptor, when parsed, must contain a number of well-specified
  505.   fields, including fields for its nickname and identity.
  506.  
  507.   If there is an error in parsing the descriptor, the server must send a "554
  508.   Invalid descriptor" reply.  If the descriptor is well-formed but the server
  509.   chooses not to add it, it must reply with a 251 message whose body explains
  510.   why the server was not added.  If the descriptor is added, Tor replies with
  511.   "250 OK".
  512.  
  513. 3.15. REDIRECTSTREAM
  514.  
  515.   Sent from the client to the server. The syntax is:
  516.     "REDIRECTSTREAM" SP StreamID SP Address (SP Port) CRLF
  517.  
  518.   Tells the server to change the exit address on the specified stream.  If
  519.   Port is specified, changes the destination port as well.  No remapping
  520.   is performed on the new provided address.
  521.  
  522.   To be sure that the modified address will be used, this event must be sent
  523.   after a new stream event is received, and before attaching this stream to
  524.   a circuit.
  525.  
  526.   Tor replies with "250 OK" on success.
  527.  
  528. 3.16. CLOSESTREAM
  529.  
  530.   Sent from the client to the server.  The syntax is:
  531.  
  532.     "CLOSESTREAM" SP StreamID SP Reason *(SP Flag) CRLF
  533.  
  534.   Tells the server to close the specified stream.  The reason should be one
  535.   of the Tor RELAY_END reasons given in tor-spec.txt, as a decimal.  Flags is
  536.   not used currently; Tor servers SHOULD ignore unrecognized flags.  Tor may
  537.   hold the stream open for a while to flush any data that is pending.
  538.  
  539.   Tor replies with "250 OK" on success, or a 512 if there aren't enough
  540.   arguments, or a 552 if it doesn't recognize the StreamID or reason.
  541.  
  542. 3.17. CLOSECIRCUIT
  543.  
  544.    The syntax is:
  545.      CLOSECIRCUIT SP CircuitID *(SP Flag) CRLF
  546.      Flag = "IfUnused"
  547.  
  548.   Tells the server to close the specified circuit.   If "IfUnused" is
  549.   provided, do not close the circuit unless it is unused.
  550.  
  551.   Other flags may be defined in the future; Tor SHOULD ignore unrecognized
  552.   flags.
  553.  
  554.   Tor replies with "250 OK" on success, or a 512 if there aren't enough
  555.   arguments, or a 552 if it doesn't recognize the CircuitID.
  556.  
  557. 3.18. QUIT
  558.  
  559.   Tells the server to hang up on this controller connection. This command
  560.   can be used before authenticating.
  561.  
  562. 4. Replies
  563.  
  564.   Reply codes follow the same 3-character format as used by SMTP, with the
  565.   first character defining a status, the second character defining a
  566.   subsystem, and the third designating fine-grained information.
  567.  
  568.   The TC protocol currently uses the following first characters:
  569.  
  570.     2yz   Positive Completion Reply
  571.        The command was successful; a new request can be started.
  572.  
  573.     4yz   Temporary Negative Completion reply
  574.        The command was unsuccessful but might be reattempted later.
  575.  
  576.     5yz   Permanent Negative Completion Reply
  577.        The command was unsuccessful; the client should not try exactly
  578.        that sequence of commands again.
  579.  
  580.     6yz   Asynchronous Reply
  581.        Sent out-of-order in response to an earlier SETEVENTS command.
  582.  
  583.   The following second characters are used:
  584.  
  585.     x0z   Syntax
  586.        Sent in response to ill-formed or nonsensical commands.
  587.  
  588.     x1z   Protocol
  589.        Refers to operations of the Tor Control protocol.
  590.  
  591.     x5z   Tor
  592.        Refers to actual operations of Tor system.
  593.  
  594.   The following codes are defined:
  595.  
  596.      250 OK
  597.      251 Operation was unnecessary
  598.          [Tor has declined to perform the operation, but no harm was done.]
  599.  
  600.      451 Resource exhausted
  601.  
  602.      500 Syntax error: protocol
  603.  
  604.      510 Unrecognized command
  605.      511 Unimplemented command
  606.      512 Syntax error in command argument
  607.      513 Unrecognized command argument
  608.      514 Authentication required
  609.      515 Bad authentication
  610.  
  611.      550 Unspecified Tor error
  612.  
  613.      551 Internal error
  614.                [Something went wrong inside Tor, so that the client's
  615.                 request couldn't be fulfilled.]
  616.  
  617.      552 Unrecognized entity
  618.                [A configuration key, a stream ID, circuit ID, event,
  619.                 mentioned in the command did not actually exist.]
  620.  
  621.      553 Invalid configuration value
  622.          [The client tried to set a configuration option to an
  623.            incorrect, ill-formed, or impossible value.]
  624.  
  625.      554 Invalid descriptor
  626.  
  627.      555 Unmanaged entity
  628.  
  629.      650 Asynchronous event notification
  630.  
  631.   Unless specified to have specific contents, the human-readable messages
  632.   in error replies should not be relied upon to match those in this document.
  633.  
  634. 4.1. Asynchronous events
  635.  
  636.   These replies can be sent after a corresponding SETEVENTS command has been
  637.   received.  They will not be interleaved with other Reply elements, but they
  638.   can appear between a command and its corresponding reply.  For example,
  639.   this sequence is possible:
  640.  
  641.      C: SETEVENTS CIRC
  642.      S: 250 OK
  643.      C: GETCONF SOCKSPORT ORPORT
  644.      S: 650 CIRC 1000 EXTENDED moria1,moria2
  645.      S: 250-SOCKSPORT=9050
  646.      S: 250 ORPORT=0
  647.  
  648.   But this sequence is disallowed:
  649.      C: SETEVENTS CIRC
  650.      S: 250 OK
  651.      C: GETCONF SOCKSPORT ORPORT
  652.      S: 250-SOCKSPORT=9050
  653.      S: 650 CIRC 1000 EXTENDED moria1,moria2
  654.      S: 250 ORPORT=0
  655.  
  656.   Clients SHOULD tolerate more arguments in an asynchonous reply than
  657.   expected, and SHOULD tolerate more lines in an asynchronous reply than
  658.   expected.  For instance, a client that expects a CIRC message like:
  659.       650 CIRC 1000 EXTENDED moria1,moria2
  660.   should tolerate:
  661.       650-CIRC 1000 EXTENDED moria1,moria2 0xBEEF
  662.       650-EXTRAMAGIC=99
  663.       650 ANONYMITY=high
  664.  
  665.   If clients ask for extended events, then each event line as specified below
  666.   will be followed by additional extensions.  Clients that do so MUST
  667.   tolerate additional arguments and lines.  Additional lines will be of the
  668.   form
  669.       "650" ("-"/" ") KEYWORD ["=" ARGUMENTS] CRLF
  670.   Additional arguments will be of the form
  671.       SP KEYWORD ["=" ( QuotedString / * NonSpDquote ) ]
  672.   Such clients MUST tolerate lines with keywords they do not recognize.
  673.  
  674. 4.1.1. Circuit status changed
  675.  
  676.    The syntax is:
  677.  
  678.      "650" SP "CIRC" SP CircuitID SP CircStatus SP Path
  679.  
  680.       CircStatus =
  681.                "LAUNCHED" / ; circuit ID assigned to new circuit
  682.                "BUILT"    / ; all hops finished, can now accept streams
  683.                "EXTENDED" / ; one more hop has been completed
  684.                "FAILED"   / ; circuit closed (was not built)
  685.                "CLOSED"     ; circuit closed (was built)
  686.  
  687.       Path = ServerID *("," ServerID)
  688.  
  689. 4.1.2. Stream status changed
  690.  
  691.     The syntax is:
  692.  
  693.       "650" SP "STREAM" SP StreamID SP StreamStatus SP CircID SP Target
  694.  
  695.       StreamStatus =
  696.                "NEW"          / ; New request to connect
  697.                "NEWRESOLVE"   / ; New request to resolve an address
  698.                "SENTCONNECT"  / ; Sent a connect cell along a circuit
  699.                "SENTRESOLVE"  / ; Sent a resolve cell along a circuit
  700.                "SUCCEEDED"    / ; Received a reply; stream established
  701.                "FAILED"       / ; Stream failed and not retriable
  702.                "CLOSED"       / ; Stream closed
  703.                "DETACHED"       ; Detached from circuit; still retriable
  704.  
  705.        Target = Address ":" Port
  706.  
  707.   The circuit ID designates which circuit this stream is attached to.  If
  708.   the stream is unattached, the circuit ID "0" is given.
  709.  
  710. 4.1.3. OR Connection status changed
  711.  
  712.   The syntax is:
  713.     "650" SP "ORCONN" SP (ServerID / Target) SP ORStatus
  714.  
  715.     ORStatus = "NEW" / "LAUNCHED" / "CONNECTED" / "FAILED" / "CLOSED"
  716.  
  717.   NEW is for incoming connections, and LAUNCHED is for outgoing
  718.   connections. CONNECTED means the TLS handshake has finished (in
  719.   either direction). FAILED means a connection is being closed that
  720.   hasn't finished its handshake, and CLOSED is for connections that
  721.   have handshaked.
  722.  
  723.   A ServerID is specified unless it's a NEW connection, in which
  724.   case we don't know what server it is yet, so we use Address:Port.
  725.  
  726. 4.1.4. Bandwidth used in the last second
  727.  
  728.   The syntax is:
  729.      "650" SP "BW" SP BytesRead SP BytesWritten
  730.      BytesRead = 1*DIGIT
  731.      BytesWritten = 1*DIGIT
  732.  
  733. 4.1.5. Log message
  734.  
  735.   The syntax is:
  736.      "650" SP Severity SP ReplyText
  737.   or
  738.      "650+" Severity CRLF Data
  739.  
  740.      Severity = "DEBUG" / "INFO" / "NOTICE" / "WARN"/ "ERR"
  741.  
  742. 4.1.6. New descriptors available
  743.  
  744.   Syntax:
  745.      "650" SP "NEWDESC" 1*(SP ServerID)
  746.  
  747. 4.1.7. New Address mapping
  748.  
  749.   Syntax:
  750.      "650" SP "ADDRMAP" SP Address SP Address SP Expiry
  751.      Expiry = DQOUTE ISOTime DQUOTE / "NEVER"
  752.  
  753. 4.1.8. Descriptors uploaded to us in our role as authoritative dirserver
  754.  
  755.   Syntax:
  756.      "650" "+" "AUTHDIR_NEWDESCS" CRLF Action CRLF Message CRLF
  757.        Descriptor CRLF "." CRLF
  758.      Action = "ACCEPTED" / "DROPPED" / "REJECTED"
  759.      Message = Text
  760.  
  761. 5. Implementation notes
  762.  
  763. 5.1. Authentication
  764.  
  765.   By default, the current Tor implementation trusts all local users.
  766.  
  767.   If the 'CookieAuthentication' option is true, Tor writes a "magic cookie"
  768.   file named "control_auth_cookie" into its data directory.  To authenticate,
  769.   the controller must send the contents of this file.
  770.  
  771.   If the 'HashedControlPassword' option is set, it must contain the salted
  772.   hash of a secret password.  The salted hash is computed according to the
  773.   S2K algorithm in RFC 2440 (OpenPGP), and prefixed with the s2k specifier.
  774.   This is then encoded in hexadecimal, prefixed by the indicator sequence
  775.   "16:".  Thus, for example, the password 'foo' could encode to:
  776.      16:660537E3E1CD49996044A3BF558097A981F539FEA2F9DA662B4626C1C2
  777.         ++++++++++++++++**^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  778.            salt                       hashed value
  779.                        indicator
  780.   You can generate the salt of a password by calling
  781.            'tor --hash-password <password>'
  782.   or by using the example code in the Python and Java controller libraries.
  783.   To authenticate under this scheme, the controller sends Tor the original
  784.   secret that was used to generate the password.
  785.  
  786. 5.2. Don't let the buffer get too big.
  787.  
  788.   If you ask for lots of events, and 16MB of them queue up on the buffer,
  789.   the Tor process will close the socket.
  790.  
  791. 5.3. Backward compatibility
  792.  
  793.   For backward compatibility with the "version 0" control protocol, Tor checks
  794.   whether the third octet the first command is zero.  If it is, Tor
  795.   assumes that version 0 is in use.  This feature is deprecated, and will be
  796.   removed in the 0.1.2.x Tor development series.
  797.  
  798.   In order to detect which version of the protocol is supported controllers
  799.   should send the sequence [00 00 0D 0A].  This is a valid and unrecognized
  800.   command in both protocol versions, and implementations can detect which
  801.   error they have received.
  802.  
  803.